

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pyamp.ui.qt.resizePolicy &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../../../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../../../../index.html" />
    <link rel="up" title="pyamp.ui.qt" href="../qt.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" accesskey="U">pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for pyamp.ui.qt.resizePolicy</h1><div class="highlight"><pre>
<span class="c"># Copyright 2012 Brett Ponsler</span>
<span class="c"># This file is part of pyamp.</span>
<span class="c">#</span>
<span class="c"># pyamp is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU General Public License as published by</span>
<span class="c"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c"># (at your option) any later version.</span>
<span class="c">#</span>
<span class="c"># pyamp is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="c"># GNU General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU General Public License</span>
<span class="c"># along with pyamp.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="sd">&#39;&#39;&#39;The resizePolicy module contains the ResizePolicy class which encapsulates</span>
<span class="sd">a specific policy for resizing widgets.</span>

<span class="sd">&#39;&#39;&#39;</span>


<div class="viewcode-block" id="ResizePolicy"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_resizePolicy.html#pyamp.ui.qt.resizePolicy.ResizePolicy">[docs]</a><span class="k">class</span> <span class="nc">ResizePolicy</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The ResizePolicy encapsulates a specific policy for resizing widgets.</span>

<span class="sd">    The possible resize policies are:</span>

<span class="sd">        * **Fixed** -- The size never changes</span>
<span class="sd">        * **Expanding** -- The size expands</span>

<span class="sd">    For a specific policy, the ResizePolicy class can return the correct size</span>
<span class="sd">    for a widget, given the widget&#39;s current size as well as the size of all</span>
<span class="sd">    of the widget&#39;s child widgets.</span>

<span class="sd">    For the *Fixed* resize policy: the size will always remain the same.</span>

<span class="sd">    For the *Expanding* resize policy: the size will always expand to fit all</span>
<span class="sd">    of the widget&#39;s children.</span>

<span class="sd">    Example::</span>

<span class="sd">        from PyQt4 import QtCore</span>
<span class="sd">        from pyamp.ui.qt import ResizePolicy</span>

<span class="sd">        # Create the size of the widget, and the list of sizes for all of</span>
<span class="sd">        # the widget&#39;s children</span>
<span class="sd">        size = QtCore.QSize(100, 200)</span>
<span class="sd">        childSizes = [QtCore.QSize(200, 500), QtCore.QSize(300, 400)]</span>

<span class="sd">        # Get the list of widths and heights for the child widgets</span>
<span class="sd">        childWidths = map(QtCore.QSize.width, childSizes)</span>
<span class="sd">        childHeights = map(QtCore.QSize.width, childSizes)</span>

<span class="sd">        # Both of these return: 100</span>
<span class="sd">        # Which is the given value of width</span>
<span class="sd">        ResizePolicy.getSize(ResizePolicy.Fixed, size.width(), childWidths)</span>
<span class="sd">        ResizePolicy.getWidth(ResizePolicy.Fixed, size, childSizes)</span>

<span class="sd">        # Both of these return: 900</span>
<span class="sd">        # Which is the sum of the childHeights list</span>
<span class="sd">        ResizePolicy.getSize(ResizePolicy.Expanding, size.height(),</span>
<span class="sd">                             childHeights)</span>
<span class="sd">        ResizePolicy.getHeight(ResizePolicy.Fixed, size, childSizes)</span>

<span class="sd">    &#39;&#39;&#39;</span>
    <span class="n">Fixed</span> <span class="o">=</span> <span class="mi">0</span>
    <span class="n">Expanding</span> <span class="o">=</span> <span class="mi">1</span>

    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="ResizePolicy.getWidth"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_resizePolicy.html#pyamp.ui.qt.resizePolicy.ResizePolicy.getWidth">[docs]</a>    <span class="k">def</span> <span class="nf">getWidth</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;For the given resize policy, get the correct width for the size of</span>
<span class="sd">        the widget as well as the size of all of the widget&#39;s children.</span>

<span class="sd">        * resizePolicy -- The resize policy</span>
<span class="sd">        * size -- The main :class:`PyQt4.QtCore.QSize` of the widget</span>
<span class="sd">        * sizeList -- The list of :class:`PyQt4.QtCore.QSize` for sub widgets</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">widthList</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">QtCore</span><span class="o">.</span><span class="n">QSize</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">cls</span><span class="o">.</span><span class="n">getSize</span><span class="p">(</span><span class="n">policy</span><span class="p">,</span> <span class="n">size</span><span class="o">.</span><span class="n">width</span><span class="p">(),</span> <span class="n">widthList</span><span class="p">)</span>
</div>
    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="ResizePolicy.getHeight"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_resizePolicy.html#pyamp.ui.qt.resizePolicy.ResizePolicy.getHeight">[docs]</a>    <span class="k">def</span> <span class="nf">getHeight</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;For the given resize policy, get the correct height for the size of</span>
<span class="sd">        the widget as well as the size of all of the widget&#39;s children.</span>

<span class="sd">        * resizePolicy -- The resize policy</span>
<span class="sd">        * size -- The main :class:`PyQt4.QtCore.QSize` of the widget</span>
<span class="sd">        * sizeList -- The list of :class:`PyQt4.QtCore.QSize` for sub widgets</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">heightList</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">QtCore</span><span class="o">.</span><span class="n">QSize</span><span class="o">.</span><span class="n">height</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">cls</span><span class="o">.</span><span class="n">getSize</span><span class="p">(</span><span class="n">policy</span><span class="p">,</span> <span class="n">size</span><span class="o">.</span><span class="n">height</span><span class="p">(),</span> <span class="n">heightList</span><span class="p">)</span>
</div>
    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="ResizePolicy.getSize"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_resizePolicy.html#pyamp.ui.qt.resizePolicy.ResizePolicy.getSize">[docs]</a>    <span class="k">def</span> <span class="nf">getSize</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">policy</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Get the correct size based on the given resize policy.</span>

<span class="sd">        * resizePolicy -- The resize policy</span>
<span class="sd">        * size -- The main single size (width or height) of the widget</span>
<span class="sd">        * sizeList -- The list of the single dimension size (widths or heights)</span>
<span class="sd">                      of widgets&#39;s children</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">policyMap</span> <span class="o">=</span> <span class="p">{</span>
            <span class="n">cls</span><span class="o">.</span><span class="n">Fixed</span><span class="p">:</span> <span class="n">cls</span><span class="o">.</span><span class="n">__getFixedSize</span><span class="p">,</span>
            <span class="n">cls</span><span class="o">.</span><span class="n">Expanding</span><span class="p">:</span> <span class="n">cls</span><span class="o">.</span><span class="n">__getExpandingSize</span>
            <span class="p">}</span>

        <span class="n">policyFn</span> <span class="o">=</span> <span class="n">policyMap</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">policy</span><span class="p">)</span>
        <span class="k">if</span> <span class="n">policyFn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">policyFn</span><span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">&quot;Unknown Policy [</span><span class="si">%s</span><span class="s">]&quot;</span> <span class="o">%</span> <span class="n">policy</span><span class="p">)</span>
</div>
    <span class="nd">@classmethod</span>
    <span class="k">def</span> <span class="nf">__getFixedSize</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">_sizeList</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Return the fixed size.</span>

<span class="sd">        * resizePolicy -- The resize policy</span>
<span class="sd">        * size -- The main size (width or height) of the widget</span>
<span class="sd">        * _sizeList -- The list of the size (widths or heights) of sub widgets</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">return</span> <span class="n">size</span>

    <span class="nd">@classmethod</span>
    <span class="k">def</span> <span class="nf">__getExpandingSize</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">_size</span><span class="p">,</span> <span class="n">sizeList</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Return the expanding size.</span>

<span class="sd">        * resizePolicy -- The resize policy</span>
<span class="sd">        * _size -- The main size (width or height) of the widget</span>
<span class="sd">        * sizeList -- The list of the size (widths or heights) of sub widgets</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="c"># Return the sum of all the subwidget sizes</span>
        <span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="n">sizeList</span><span class="p">)</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" >pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>